<?php
/**
 * Mechanism
 *
 * LICENSE
 *
 * Copyright (c) 2011, Sergey A. Ivonchik <BreatheInMyVoid@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following disclaimer
 *   in the documentation and/or other materials provided with the
 *   distribution.
 * * Neither the name of the  nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @package Mechanism
 * @license http://www.opensource.org/licenses/bsd-license
 * @author Sergey A. Ivonchik <BreatheInMyVoid@gmail.com>
 * @copyright Copyright (c) 2011 Sergey A. Ivonchik
 */

namespace Mechanism {
	use Mechanism\Gear\IGear;
	/**
	 * IMechanical interface
	 *
 	 * @package Mechanism
 	 * @author Sergey A. Ivonchik <BreatheInMyVoid@gmail.com>
	 */
	interface IMechanical {
		/**
		 * Constructor
		 *
		 * @param object $object
		 */
		public function __construct( $object );

		/**
		 * Set overloading
		 *
		 * Give access to properties of mechanized object
		 *
		 * @param string $name
		 * @param string $value
		 */
		public function __set( $name, $value );

		/**
		 * Get overloading
		 *
		 * Give access to properties of mechanized object
		 *
		 * @param string $name
		 * @param string $value
		 * @return mixed $value
		 */
		public function __get( $name );

		/**
		 * Call overloading
		 *
		 * Gives access to methods of mechanized object
		 * and calls gears
		 *
		 * @param string $name
		 * @param array $args
		 * @return mixed $value
		 */
		public function __call( $name, $args );

		/**
		 * Add gear for mechanized object
		 *
		 * @param IGear $gear
		 * @return IMechanical $mechanical
		 */
		public function add_gear( IGear $gear );

		/**
		 * Get gear by name
		 *
		 * @param string $name
		 */
		public function get_gear( $name );

		/**
		 * Get all added gears
		 *
		 * @return array $gears
		 */
		public function get_gears( );

		/**
		 * Unmechanize
		 *
		 * Returns unmechanized object
		 *
		 * @return object $unmechanized
		 */
		public function unmechanize( );
	}
}